pp108 : periods Property

periods Property

 

 

 


An XML Object reference to define the tasks or important days in the calendar control. The dates within a period are highlighted in the calendar and display a tooltip on mouse-over.

A period can contain selected dates or ranges of dates and can contain monthly- or yearly-recurring tasks.

HTML

 
<div cordysType="wcp.library.ui.Calendar" id=calendarID periods="xmlperiods.XMLDocument" style="position:absolute;display:none;width:250;height:180">
...
</div>

Scripting

calendarID.periods = xmlperiods.XMLDocument

 

Parameters

Parameter

Description

xmlPeriods

Object that denotes the XML document in which information about the events is defined.

 

Example

Consider the following document in which the below sales event is scheduled:

  • Sales Event: 22/10/2007 â€" 25/10/2007
  • Christmas: Recurring event. This is a yearly event, therefore the <year> node is not used.

XML

 
<xml id="xmlPeriods">
    <periods>
        <period>
            <description>Sales Event</description>
            <from>
                <date>22</date>
                <month>10</month>
                <year>2007</year>
            </from>
            <to>
                <date>25</date>
                <month>10</month>
                <year>2007</year>
            </to>
        </period>
        <period>
            <description>Christmas</description>
            <from>
                <date>25</date>
                <month>12</month>
            </from>
            <to>
                <date>26</date>
                <month>12</month>
            </to>
        </period>        
    </periods>
</xml>



In the above XML, the description will be shown as a tooltip for the particular calendar date(s).

For the above XML, the calendar is declared as below:

HTML

 
<div cordysType="wcp.library.ui.Calendar" id="cal" style="width:250px;height:180px" periods="xmlPeriods.XMLDocument">
...
</div>

 

See Also


calendar